Renames a file or folder.

OSErr PBRenameUnicodeSync (
    FSRefParam *paramBlock
);

paramBlock

A pointer to a parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion routine.

• ioResult

  On output, the result code of the function.

• ref

  On input, the file or directory to be renamed.

• nameLength

  On input, the length of the new name in Unicode characters.

• name

  On input, a pointer to the new Unicode name of the specified file or directory.

• textEncodingHint

  On input, a suggested text encoding to use for the name; pass kTextEncodingUnknown to use a default value.

• newRef

  On output, a a pointer to the new FSRef for the file or directory. This parameter is optional and you may set it to NULL.

AVAILABILITY

Supported in Carbon. Available in Mac OS 9, and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)